Scripting > CxHmiFms > CxFmsReportCtrl Object > CxFmsReportCtrl Events

CxFmsReportCtrl Events

The CxFmsReportCtrl object contains the following events.

EndRefresh

A refresh operation has completed.

Syntax

CxFmsReportCtrlObject_EventEndRefresh(Result As Integer, Status As Integer)

Parameters

Parameter Required Description

Result

Yes

An integer specifying whether the refresh succeeded or failed. Possible values for this property are as follows.

  • 0 – Success
  • 1 - Failure

Status

Yes

An integer specifying whether or not the refresh was canceled. Possible values for this property are as follows.

  • 0 – Not canceled
  • 1 - Canceled

Example

The following example displays a message box if the refresh was canceled.

  

Sub FmsReport_EventEndRefresh(Result, Status)

Dim This : Set This = FmsReport

If Status = 1 Then

MsgBox "Refresh canceled"

End If

End Sub

Back to top

Initialize

The control is initialized.

Syntax

CxFmsReportCtrlObject_EventInitialize()

Example

The following example displays a message box when the control is initialized.

  

Sub FmsReport_EventInitialize()

Dim This : Set This = FmsReport

MsgBox "Control initialized"

End Sub

Back to top

PumpData

(Obsolete)

Back to top

UpdateReportDefinitions

The report definition has been changed.

Syntax

CxFmsReportCtrlObject_EventUpdateReportDefinitions(lpszReportDefXmo As String)

Remarks

This event will be fired if a report definition is saved after it is modified.

Example

The following example displays a message box when the report definition changes.

Sub FmsReport_EventUpdateReportDefinitions(lpszReportDefXml)

Dim This : Set This = FmsReport

MsgBox "Report definition changed"

End Sub

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.